Skip to content

Add global deprecation banner to all Entity docs pages with OpenAPI link - #409

Open
Schaukelking with Copilot wants to merge 1 commit into
masterfrom
copilot/deprecate-markdown-api-notes
Open

Add global deprecation banner to all Entity docs pages with OpenAPI link#409
Schaukelking with Copilot wants to merge 1 commit into
masterfrom
copilot/deprecate-markdown-api-notes

Conversation

Copilot AI commented Aug 27, 2026

Copy link
Copy Markdown

The Entities markdown docs are being deprecated and each entity page now needs a clear redirect to the new OpenAPI docs. This change adds a single shared deprecation note across all entity entries under entities.html.

  • Scope

    • Apply deprecation messaging to every entity detail page (/sections/*) without touching each markdown file individually.
  • Implementation

    • Updated _includes/head_custom.html to inject a styled deprecation note after the page <h1> on entity pages.
    • Added the required link text OpenAPI Documentation pointing to https://docs.mocoapp.com/api/docs/v1#description/introduction.
  • Behavior

    • Note renders only on section pages and guards against duplicate insertion.
if (!window.location.pathname.includes("/sections/")) return;

note.innerHTML =
  'This API documentation is being deprecated. Please use our <a href="https://docs.mocoapp.com/api/docs/v1#description/introduction">OpenAPI Documentation</a> instead.';

moco-1141 Deprecate Entities of Markdown API

This is what you see on every sub page of "Entities"
image

Co-authored-by: Schaukelking <48789562+Schaukelking@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants